/*
 * Sonatype Nexus (TM) Open Source Version
 * Copyright (c) 2008-present Sonatype, Inc.
 * All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
 * which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
 *
 * Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
 * of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
 * Eclipse Foundation. All other trademarks are the property of their respective owners.
 */
package org.sonatype.nexus.repository.browse.node;

/**
 * EventHandler that manages browse nodes realtime
 * @since 3.35
 */
public interface BrowseNodeEventHandler
{
  /**
   * event handling should only be carried out if this is true
   */
  boolean shouldHandle();

  /**
   * pause processing of events, once this happens, rebuilding browse nodes manually (via the task) will be required
   * after resuming processing
   */
  void pauseEventProcessing();

  /**
   * resume processing, with the knowledge that anything added while in the paused state did not get added to browse
   */
  void resumeEventProcessing();
}
